/*
 * mana (library)
 * Copyright (c) 2003 Shun Moriya <shun@mnu.sakura.ne.jp>
 *
 * The MIT License
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
 * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

/*!
 * @file
 * @brief	mana_bufferクラスに関するヘッダーファイル
 *
 * このファイルはmana_bufferクラスに関係するヘッダーファイルです。
 * mana_streamクラスは可変長バッファに関する操作を行ないます。
 *
 * @author	Shun Moriya <shun@mnu.sakura.ne.jp>
 */

#if !defined(___MANA_BUFFER_H___)
#define ___MANA_BUFFER_H___

#if defined(_LANGUAGE_C_PLUS_PLUS) || defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif

#include <stddef.h>

/*!
 * @brief	mana_bufferクラス
 *
 * mana_bufferクラスは可変長バッファを表しています。
 *
 * C++でいうところのメンバー変数ですが、C言語なので全てpublicになっています。
 * 操作用の関数を用意しているので、それらの関数を利用して操作してください。
 */
typedef struct mana_buffer
{
	char* buffer;
	size_t allocated_size;
	size_t used_size;
}mana_buffer;

/*! @brief mana_stream オブジェクトの生成 */
extern mana_buffer* mana_buffer_create(void);

/*! @brief mana_stream オブジェクトの破棄 */
extern void mana_buffer_destroy(mana_buffer* self);

/*! @brief バッファの先頭アドレスを取得 */
extern void* mana_buffer_get_buffer(mana_buffer* self);

/*! @brief 確保済みバッファサイズを取得 */
extern size_t mana_buffer_get_allocated_size(mana_buffer* self);

/*! @brief 使用しているバッファサイズを取得 */
extern size_t mana_buffer_get_used_size(mana_buffer* self);

/*! @brief データをプッシュ */
extern int mana_buffer_push(mana_buffer* self, const void* pointer, const size_t size);

#if defined(_LANGUAGE_C_PLUS_PLUS) || defined(__cplusplus) || defined(c_plusplus)
}
#endif

#endif
